| A built-in template for a PHP function PHPDoc comment. It contains a code fragment that can be included into file templates
(Templates tab) with the help of the #parse directive. The template is editable. Along with the static text, code and comments, you can also use the predefined variables that expand like macros into the corresponding values. |
| Predefined variables take the following values: | ||
| Function name. | ||
| Type hint of the function's return value. If no return types inferred, evaluates to 'void'. | ||
|
Parameters' PHPDoc comment. Generated as a number of lines '* @param type name'. If there are no parameters, evaluates to empty content. |
||
|
Exceptions' doc comment. Generated as a number of lines '* @throws type'. If there are no thrown exceptions, evaluates to empty content. |
||
Takes a value of 'static' if the function/method is static or an empty string
otherwise. For example:
#if (${STATIC} == "static") * @static
#end
|
||
|
|
Dollar sign, evaluates to a plain '$' character. | |
|
|
Current system date | |
|
|
Current system time | |
| Current year | ||
| Current month | ||
| First 3 letters of the current month name. Example: Jan, Feb, etc. | ||
| Full name of the current month. Example: January, February, etc. | ||
| Current day of the month | ||
| Current hour | ||
| Current minute | ||
| Current second | ||
| Name of the current project | ||
| Current user | ||
|
|
Marks a position where the caret must be moved after the comment is added. | |